/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef DBACCESS_CORE_API_ROWSETCACHE_HXX
#define DBACCESS_CORE_API_ROWSETCACHE_HXX

#ifndef _CONNECTIVITY_COMMONTOOLS_HXX_
#include <connectivity/CommonTools.hxx>
#endif
#ifndef _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
#include <com/sun/star/lang/XServiceInfo.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_XPREPAREDSTATEMENT_HPP_
#include <com/sun/star/sdbc/XPreparedStatement.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_XCONNECTION_HPP_
#include <com/sun/star/sdbc/XConnection.hpp>
#endif
#ifndef _COM_SUN_STAR_SDB_XSINGLESELECTQUERYANALYZER_HPP_
#include <com/sun/star/sdb/XSingleSelectQueryAnalyzer.hpp>
#endif
#ifndef _COM_SUN_STAR_SDB_XSINGLESELECTQUERYANALYZER_HPP_
#include <com/sun/star/sdb/XSingleSelectQueryAnalyzer.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_XRESULTSETMETADATASUPPLIER_HPP_
#include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_XWARNINGSSUPPLIER_HPP_
#include <com/sun/star/sdbc/XWarningsSupplier.hpp>
#endif
#ifndef _COM_SUN_STAR_SDB_XRESULTSETACCESS_HPP_
#include <com/sun/star/sdb/XResultSetAccess.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_XROW_HPP_
#include <com/sun/star/sdbc/XRow.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_XCOLUMNLOCATE_HPP_
#include <com/sun/star/sdbc/XColumnLocate.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBCX_XROWLOCATE_HPP_
#include <com/sun/star/sdbcx/XRowLocate.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_XROWUPDATE_HPP_
#include <com/sun/star/sdbc/XRowUpdate.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_XRESULTSETUPDATE_HPP_
#include <com/sun/star/sdbc/XResultSetUpdate.hpp>
#endif
#ifndef _COM_SUN_STAR_SDB_XROWSETAPPROVEBROADCASTER_HPP_
#include <com/sun/star/sdb/XRowSetApproveBroadcaster.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBC_RESULTSETTYPE_HPP_
#include <com/sun/star/sdbc/ResultSetType.hpp>
#endif
#ifndef _COM_SUN_STAR_SDBCX_XDELETEROWS_HPP_
#include <com/sun/star/sdbcx/XDeleteRows.hpp>
#endif
#ifndef _CPPUHELPER_COMPBASE11_HXX_
#include <cppuhelper/compbase11.hxx>
#endif
#ifndef _COMPHELPER_PROPERTYCONTAINER_HXX_
#include <comphelper/propertycontainer.hxx>
#endif
#ifndef COMPHELPER_COMPONENTCONTEXT_HXX
#include <comphelper/componentcontext.hxx>
#endif
#ifndef _CPPUHELPER_IMPLBASE5_HXX_
#include <cppuhelper/implbase5.hxx>
#endif
#ifndef _COMPHELPER_PROPERTY_ARRAY_HELPER_HXX_
#include <comphelper/proparrhlp.hxx>
#endif
#ifndef DBACCESS_CORE_API_ROWSETROW_HXX
#include "RowSetRow.hxx"
#endif
#ifndef DBACCESS_ROWSETCACHEITERATOR_HXX
#include "RowSetCacheIterator.hxx"
#endif

namespace connectivity
{
	class OSQLParseNode;
}
namespace dbaccess
{
	class OCacheSet;
	class ORowSetDataColumns;
	class ORowSetCacheClone;

	class ORowSetCache
	{
		friend class ORowSetBase;
		friend class ORowSet;
		friend class ORowSetClone;
		friend class ORowSetCacheIterator;

		typedef ::std::vector< TORowSetOldRowHelperRef >	TOldRowSetRows;

		//the set can be static, bookmarkable or keyset
		::com::sun::star::uno::WeakReference< ::com::sun::star::sdbc::XResultSet>		m_xSet;
		::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData >	m_xMetaData; // must be before m_aInsertRow
        ::comphelper::ComponentContext                                                  m_aContext;

		::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow>					m_xCacheSet;

		OCacheSet*						m_pCacheSet;			// is a bookmarkable, keyset or static resultset
		ORowSetMatrix*					m_pMatrix;				// represent the table struct
		ORowSetMatrix::iterator			m_aMatrixIter;			// represent a row of the table
		ORowSetMatrix::iterator			m_aMatrixEnd;			// present the row behind the last row of the table
		ORowSetCacheMap					m_aCacheIterators;
		TOldRowSetRows					m_aOldRows;

		ORowSetMatrix*					m_pInsertMatrix;		// represent the rows which should be inserted normally this is only one
		ORowSetMatrix::iterator			m_aInsertRow;			// represent a insert row

		//	ORowSetRow						m_aInsertRow;			// present the row that should be inserted
		sal_Int32						m_nLastColumnIndex;		// the last column ask for, used for wasNull()

		connectivity::OSQLTable			m_aUpdateTable;			// used for updates/deletes and inserts

		sal_Int32					m_nFetchSize;
		sal_Int32					m_nRowCount;
		sal_Int32					m_nPrivileges;
		sal_Int32					m_nPosition;				// 0 means beforefirst

		sal_Int32					m_nStartPos;				// start pos of the window zero based
		sal_Int32					m_nEndPos;					// end   pos of the window zero based

		sal_Bool					m_bRowCountFinal ;
		sal_Bool					m_bBeforeFirst ;
		sal_Bool					m_bAfterLast ;
		sal_Bool					m_bUpdated ;
		sal_Bool&					m_bModified ;			// points to the rowset member m_bModified
		sal_Bool&					m_bNew ;				// points to the rowset member m_bNew

		sal_Bool fill(ORowSetMatrix::iterator& _aIter,const ORowSetMatrix::iterator& _aEnd,sal_Int32& _nPos,sal_Bool _bCheck);
		sal_Bool reFillMatrix(sal_Int32 _nNewStartPos,sal_Int32 nNewEndPos);
		sal_Bool fillMatrix(sal_Int32 &_nNewStartPos,sal_Int32 _nNewEndPos);
		sal_Bool moveWindow();
        // returns true when a keyset needs to be created.
        sal_Bool impl_createBookmarkSet_nothrow(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >& _xRs);

		void firePropertyChange(sal_Int32 _nColumnIndex,const ::connectivity::ORowSetValue& _rOldValue);

		void rotateCacheIterator(ORowSetMatrix::difference_type _nDist);
		void updateValue(sal_Int32 columnIndex,const connectivity::ORowSetValue& x);
		// checks and set the flags isAfterLast isLast and position when afterlast is true
		void checkPositionFlags();
		void checkUpdateConditions(sal_Int32 columnIndex);
		sal_Bool checkJoin(	const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection,
							const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XSingleSelectQueryAnalyzer >& _xComposer,
							const ::rtl::OUString& _sUpdateTableName);
		sal_Bool checkInnerJoin(const ::connectivity::OSQLParseNode *pNode
							,const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _xConnection
							,const ::rtl::OUString& _sUpdateTableName);

		// clears the insert row
		void					clearInsertRow();
		ORowSetMatrix::iterator	calcPosition() const;

	protected:
		ORowSetMatrix::iterator& getEnd() { return m_aMatrixEnd;}
		// is called when after a moveToInsertRow a movement (next, etc) was called
		void cancelRowModification();
	public:
		ORowSetCache(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >& _xRs,
					 const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XSingleSelectQueryAnalyzer >& _xAnalyzer,
					 const ::comphelper::ComponentContext& _rContext,
					 const ::rtl::OUString& _rUpdateTableName,
					 sal_Bool&	_bModified,
					 sal_Bool&	_bNew,
                     const ORowSetValueVector& _aParameterValueForCache,
                     const ::rtl::OUString& i_sRowSetFilter);
		~ORowSetCache();


		// called from the rowset when a updateXXX was called for the first time
		void setUpdateIterator(const ORowSetMatrix::iterator& _rOriginalRow);
        ORowSetCacheIterator createIterator(ORowSetBase* _pRowSet);
        void deleteIterator(const ORowSetBase* _pRowSet);
		// sets the size of the matrix
		void setMaxRowSize(sal_Int32 _nSize);

		TORowSetOldRowHelperRef registerOldRow();
		void deregisterOldRow(const TORowSetOldRowHelperRef& _rRow);

	// ::com::sun::star::sdbc::XResultSetMetaDataSupplier
		::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData > getMetaData(  );

	// ::com::sun::star::sdbcx::XRowLocate
		::com::sun::star::uno::Any getBookmark(  );
		sal_Bool moveToBookmark( const ::com::sun::star::uno::Any& bookmark );
		sal_Bool moveRelativeToBookmark( const ::com::sun::star::uno::Any& bookmark, sal_Int32 rows );
		sal_Int32 compareBookmarks( const ::com::sun::star::uno::Any& first, const ::com::sun::star::uno::Any& second );
		sal_Bool hasOrderedBookmarks(  );
		sal_Int32 hashBookmark( const ::com::sun::star::uno::Any& bookmark );

	// ::com::sun::star::sdbc::XRowUpdate
		void updateBinaryStream( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& x, sal_Int32 length );
		void updateCharacterStream( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& x, sal_Int32 length );
		void updateObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Any& x );
		void updateNumericObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Any& x, sal_Int32 scale );

	// ::com::sun::star::sdbc::XResultSet
		sal_Bool next(  );
		sal_Bool isBeforeFirst(  );
		sal_Bool isAfterLast(  );
		sal_Bool isFirst(  );
		sal_Bool isLast(  );
		sal_Bool beforeFirst(  );
		sal_Bool afterLast(  );
		sal_Bool first(  );
		sal_Bool last(  );
		sal_Int32 getRow(  );
		sal_Bool absolute( sal_Int32 row );
		sal_Bool relative( sal_Int32 rows );
		sal_Bool previous(  );
		void refreshRow(  );
		sal_Bool rowUpdated(  );
		sal_Bool rowInserted(  );

	// ::com::sun::star::sdbc::XResultSetUpdate
		sal_Bool insertRow();
		void resetInsertRow(sal_Bool _bClearInsertRow);

		void updateRow();
		void updateRow( ORowSetMatrix::iterator& _rUpdateRow );
		bool deleteRow();
		void cancelRowUpdates(  );
		void moveToInsertRow(  );
	};
}
#endif

